home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / grafix / tools / jpeg / jpeg-6a / install.doc < prev    next >
Text File  |  1996-02-07  |  45KB  |  932 lines
  1. INSTALLATION INSTRUCTIONS for the Independent JPEG Group's JPEG software
  2.  
  3. Copyright (C) 1991-1996, Thomas G. Lane.
  4. This file is part of the Independent JPEG Group's software.
  5. For conditions of distribution and use, see the accompanying README file.
  6.  
  7.  
  8. This file explains how to configure and install the IJG software.  We have
  9. tried to make this software extremely portable and flexible, so that it can be
  10. adapted to almost any environment.  The downside of this decision is that the
  11. installation process is complicated.  We have provided shortcuts to simplify
  12. the task on common systems.  But in any case, you will need at least a little
  13. familiarity with C programming and program build procedures for your system.
  14.  
  15. If you are only using this software as part of a larger program, the larger
  16. program's installation procedure may take care of configuring the IJG code.
  17. For example, Ghostscript's installation script will configure the IJG code.
  18. You don't need to read this file if you just want to compile Ghostscript.
  19.  
  20. If you are on a Unix machine, you may not need to read this file at all.
  21. Try doing
  22.     ./configure
  23.     make
  24.     make test
  25. If that doesn't complain, do
  26.     make install
  27. (better do "make -n install" first to see if the makefile will put the files
  28. where you want them).  Read further if you run into snags or want to customize
  29. the code for your system.
  30.  
  31.  
  32. TABLE OF CONTENTS
  33. -----------------
  34.  
  35. Before you start
  36. Configuring the software:
  37.     using the automatic "configure" script
  38.     using one of the supplied jconfig and makefile files
  39.     by hand
  40. Building the software
  41. Testing the software
  42. Installing the software
  43. Optional stuff
  44. Optimization
  45. Hints for specific systems
  46.  
  47.  
  48. BEFORE YOU START
  49. ================
  50.  
  51. Before installing the software you must unpack the distributed source code.
  52. Since you are reading this file, you have probably already succeeded in this
  53. task.  However, there is a potential for error if you needed to convert the
  54. files to the local standard text file format (for example, if you are on
  55. MS-DOS you may have converted LF end-of-line to CR/LF).  You must apply
  56. such conversion to all the files EXCEPT those whose names begin with "test".
  57. The test files contain binary data; if you change them in any way then the
  58. self-test will give bad results.
  59.  
  60. Please check the last section of this file to see if there are hints for the
  61. specific machine or compiler you are using.
  62.  
  63.  
  64. CONFIGURING THE SOFTWARE
  65. ========================
  66.  
  67. To configure the IJG code for your system, you need to create two files:
  68.   * jconfig.h: contains values for system-dependent #define symbols.
  69.   * Makefile: controls the compilation process.
  70. (On a non-Unix machine, you may create "project files" or some other
  71. substitute for a Makefile.  jconfig.h is needed in any environment.)
  72.  
  73. We provide three different ways to generate these files:
  74.   * On a Unix system, you can just run the "configure" script.
  75.   * We provide sample jconfig files and makefiles for popular machines;
  76.     if your machine matches one of the samples, just copy the right sample
  77.     files to jconfig.h and Makefile.
  78.   * If all else fails, read the instructions below and make your own files.
  79.  
  80.  
  81. Configuring the software using the automatic "configure" script
  82. ---------------------------------------------------------------
  83.  
  84. If you are on a Unix machine, you can just type
  85.     ./configure
  86. and let the configure script construct appropriate configuration files.
  87. If you're using "csh" on an old version of System V, you might need to type
  88.     sh configure
  89. instead to prevent csh from trying to execute configure itself.
  90. Expect configure to run for a few minutes, particularly on slower machines;
  91. it works by compiling a series of test programs.
  92.  
  93. Configure was created with GNU Autoconf and it follows the usual conventions
  94. for GNU configure scripts.  It makes a few assumptions that you may want to
  95. override.  You can do this by providing optional switches to configure:
  96.  
  97. * Configure will use gcc (GNU C compiler) if it's available, otherwise cc.
  98. To force a particular compiler to be selected, use the CC option, for example
  99.     ./configure CC='cc'
  100. The same method can be used to include any unusual compiler switches.
  101. For example, on HP-UX you probably want to say
  102.     ./configure CC='cc -Aa'
  103. to get HP's compiler to run in ANSI mode.
  104.  
  105. * The default CFLAGS setting is "-O".  You can override this by saying,
  106. for example, ./configure CFLAGS='-O2'.
  107.  
  108. * Configure will set up the makefile so that "make install" will install files
  109. into /usr/local/bin, /usr/local/man, etc.  You can specify an installation
  110. prefix other than "/usr/local" by giving configure the option "--prefix=PATH".
  111.  
  112. * If you don't have a lot of swap space, you may need to enable the IJG
  113. software's internal virtual memory mechanism.  To do this, give the option
  114. "--enable-maxmem=N" where N is the default maxmemory limit in megabytes.
  115. This is discussed in more detail under "Selecting a memory manager", below.
  116. You probably don't need to worry about this on reasonably-sized Unix machines,
  117. unless you plan to process very large images.
  118.  
  119. Configure has some other features that are useful if you are cross-compiling
  120. or working in a network of multiple machine types; but if you need those
  121. features, you probably already know how to use them.
  122.  
  123.  
  124. Configuring the software using one of the supplied jconfig and makefile files
  125. -----------------------------------------------------------------------------
  126.  
  127. If you have one of these systems, you can just use the provided configuration
  128. files:
  129.  
  130. Makefile    jconfig file    System and/or compiler
  131.  
  132. makefile.manx    jconfig.manx    Amiga, Manx Aztec C
  133. makefile.sas    jconfig.sas    Amiga, SAS C
  134. mak*jpeg.st    jconfig.st    Atari ST/STE/TT, Pure C or Turbo C
  135. makefile.bcc    jconfig.bcc    MS-DOS or OS/2, Borland C
  136. makefile.dj    jconfig.dj    MS-DOS, DJGPP (Delorie's port of GNU C)
  137. makefile.mc6    jconfig.mc6    MS-DOS, Microsoft C version 6.x and up
  138. makefile.wat    jconfig.wat    MS-DOS, OS/2, or Windows NT, Watcom C
  139. makefile.mms    jconfig.vms    Digital VMS, with MMS software
  140. makefile.vms    jconfig.vms    Digital VMS, without MMS software
  141.  
  142. Copy the proper jconfig file to jconfig.h and the makefile to Makefile
  143. (or whatever your system uses as the standard makefile name).  For the
  144. Atari, we provide four project files; see the Atari hints below.
  145.  
  146.  
  147. Configuring the software by hand
  148. --------------------------------
  149.  
  150. First, generate a jconfig.h file.  If you are moderately familiar with C,
  151. the comments in jconfig.doc should be enough information to do this; just
  152. copy jconfig.doc to jconfig.h and edit it appropriately.  Otherwise, you may
  153. prefer to use the ckconfig.c program.  You will need to compile and execute
  154. ckconfig.c by hand --- we hope you know at least enough to do that.
  155. ckconfig.c may not compile the first try (in fact, the whole idea is for it
  156. to fail if anything is going to).  If you get compile errors, fix them by
  157. editing ckconfig.c according to the directions given in ckconfig.c.  Once
  158. you get it to run, it will write a suitable jconfig.h file, and will also
  159. print out some advice about which makefile to use.
  160.  
  161. You may also want to look at the canned jconfig files, if there is one for a
  162. system similar to yours.
  163.  
  164. Second, select a makefile and copy it to Makefile (or whatever your system
  165. uses as the standard makefile name).  The most generic makefiles we provide
  166. are
  167.     makefile.ansi:    if your C compiler supports function prototypes
  168.     makefile.unix:    if not.
  169. (You have function prototypes if ckconfig.c put "#define HAVE_PROTOTYPES"
  170. in jconfig.h.)  You may want to start from one of the other makefiles if
  171. there is one for a system similar to yours.
  172.  
  173. Look over the selected Makefile and adjust options as needed.  In particular
  174. you may want to change the CC and CFLAGS definitions.  For instance, if you
  175. are using GCC, set CC=gcc.  If you had to use any compiler switches to get
  176. ckconfig.c to work, make sure the same switches are in CFLAGS.
  177.  
  178. If you are on a system that doesn't use makefiles, you'll need to set up
  179. project files (or whatever you do use) to compile all the source files and
  180. link them into executable files cjpeg, djpeg, jpegtran, rdjpgcom, and wrjpgcom.
  181. See the file lists in any of the makefiles to find out which files go into
  182. each program.  Note that the provided makefiles all make a "library" file
  183. libjpeg first, but you don't have to do that if you don't want to; the file
  184. lists identify which source files are actually needed for compression,
  185. decompression, or both.  As a last resort, you can make a batch script that
  186. just compiles everything and links it all together; makefile.vms is an example
  187. of this (it's for VMS systems that have no make-like utility).
  188.  
  189. Here are comments about some specific configuration decisions you'll
  190. need to make:
  191.  
  192. Command line style
  193. ------------------
  194.  
  195. These programs can use a Unix-like command line style which supports
  196. redirection and piping, like this:
  197.     cjpeg inputfile >outputfile
  198.     cjpeg <inputfile >outputfile
  199.     source program | cjpeg >outputfile
  200. The simpler "two file" command line style is just
  201.     cjpeg inputfile outputfile
  202. You may prefer the two-file style, particularly if you don't have pipes.
  203.  
  204. You MUST use two-file style on any system that doesn't cope well with binary
  205. data fed through stdin/stdout; this is true for some MS-DOS compilers, for
  206. example.  If you're not on a Unix system, it's safest to assume you need
  207. two-file style.  (But if your compiler provides either the Posix-standard
  208. fdopen() library routine or a Microsoft-compatible setmode() routine, you
  209. can safely use the Unix command line style, by defining USE_FDOPEN or
  210. USE_SETMODE respectively.)
  211.  
  212. To use the two-file style, make jconfig.h say "#define TWO_FILE_COMMANDLINE".
  213.  
  214. Selecting a memory manager
  215. --------------------------
  216.  
  217. The IJG code is capable of working on images that are too big to fit in main
  218. memory; data is swapped out to temporary files as necessary.  However, the
  219. code to do this is rather system-dependent.  We provide five different
  220. memory managers:
  221.  
  222. * jmemansi.c    This version uses the ANSI-standard library routine tmpfile(),
  223.         which not all non-ANSI systems have.  On some systems
  224.         tmpfile() may put the temporary file in a non-optimal
  225.         location; if you don't like what it does, use jmemname.c.
  226.  
  227. * jmemname.c    This version creates named temporary files.  For anything
  228.         except a Unix machine, you'll need to configure the
  229.         select_file_name() routine appropriately; see the comments
  230.         near the head of jmemname.c.  If you use this version, define
  231.         NEED_SIGNAL_CATCHER in jconfig.h to make sure the temp files
  232.         are removed if the program is aborted.
  233.  
  234. * jmemnobs.c    (That stands for No Backing Store :-).)  This will compile on
  235.         almost any system, but it assumes you have enough main memory
  236.         or virtual memory to hold the biggest images you work with.
  237.  
  238. * jmemdos.c    This should be used with most 16-bit MS-DOS compilers.
  239.         See the system-specific notes about MS-DOS for more info.
  240.         IMPORTANT: if you use this, define USE_MSDOS_MEMMGR in
  241.         jconfig.h, and include the assembly file jmemdosa.asm in the
  242.         programs.  The supplied makefiles and jconfig files for
  243.         16-bit MS-DOS compilers already do both.
  244.  
  245. * jmemmac.c    Custom version for Apple Macintosh; see the system-specific
  246.         notes for Macintosh for more info.
  247.  
  248. To use a particular memory manager, change the SYSDEPMEM variable in your
  249. makefile to equal the corresponding object file name (for example, jmemansi.o
  250. or jmemansi.obj for jmemansi.c).
  251.  
  252. If you have plenty of (real or virtual) main memory, just use jmemnobs.c.
  253. "Plenty" means about ten bytes for every pixel in the largest images
  254. you plan to process, so a lot of systems don't meet this criterion.
  255. If yours doesn't, try jmemansi.c first.  If that doesn't compile, you'll have
  256. to use jmemname.c; be sure to adjust select_file_name() for local conditions.
  257. You may also need to change unlink() to remove() in close_backing_store().
  258.  
  259. Except with jmemnobs.c or jmemmac.c, you need to adjust the DEFAULT_MAX_MEM
  260. setting to a reasonable value for your system (either by adding a #define for
  261. DEFAULT_MAX_MEM to jconfig.h, or by adding a -D switch to the Makefile).
  262. This value limits the amount of data space the program will attempt to
  263. allocate.  Code and static data space isn't counted, so the actual memory
  264. needs for cjpeg or djpeg are typically 100 to 150Kb more than the max-memory
  265. setting.  Larger max-memory settings reduce the amount of I/O needed to
  266. process a large image, but too large a value can result in "insufficient
  267. memory" failures.  On most Unix machines (and other systems with virtual
  268. memory), just set DEFAULT_MAX_MEM to several million and forget it.  At the
  269. other end of the spectrum, for MS-DOS machines you probably can't go much
  270. above 300K to 400K.  (On MS-DOS the value refers to conventional memory only.
  271. Extended/expanded memory is handled separately by jmemdos.c.)
  272.  
  273.  
  274. BUILDING THE SOFTWARE
  275. =====================
  276.  
  277. Now you should be able to compile the software.  Just say "make" (or
  278. whatever's necessary to start the compilation).  Have a cup of coffee.
  279.  
  280. Here are some things that could go wrong:
  281.  
  282. If your compiler complains about undefined structures, you should be able to
  283. shut it up by putting "#define INCOMPLETE_TYPES_BROKEN" in jconfig.h.
  284.  
  285. If you have trouble with missing system include files or inclusion of the
  286. wrong ones, read jinclude.h.  This shouldn't happen if you used configure
  287. or ckconfig.c to set up jconfig.h.
  288.  
  289. There are a fair number of routines that do not use all of their parameters;
  290. some compilers will issue warnings about this, which you can ignore.  There
  291. are also a few configuration checks that may give "unreachable code" warnings.
  292. Any other warning deserves investigation.
  293.  
  294. If you don't have a getenv() library routine, define NO_GETENV.
  295.  
  296. Also see the system-specific hints, below.
  297.  
  298.  
  299. TESTING THE SOFTWARE
  300. ====================
  301.  
  302. As a quick test of functionality we've included a small sample image in
  303. several forms:
  304.     testorig.jpg    Starting point for the djpeg tests.
  305.     testimg.ppm    The output of djpeg testorig.jpg
  306.     testimg.gif    The output of djpeg -gif testorig.jpg
  307.     testimg.jpg    The output of cjpeg testimg.ppm
  308.     testprog.jpg    Progressive-mode equivalent of testorig.jpg.
  309.     testimgp.jpg    The output of cjpeg -progressive -optimize testimg.ppm
  310. (The first- and second-generation .jpg files aren't identical since JPEG is
  311. lossy.)  If you can generate duplicates of the testimg* files then you
  312. probably have working programs.
  313.  
  314. With most of the makefiles, "make test" will perform the necessary
  315. comparisons.
  316.  
  317. If you're using a makefile that doesn't provide the test option, run djpeg
  318. and cjpeg by hand and compare the output files to testimg* with whatever
  319. binary file comparison tool you have.  The files should be bit-for-bit
  320. identical.
  321.  
  322. If the programs complain "MAX_ALLOC_CHUNK is wrong, please fix", then you
  323. need to reduce MAX_ALLOC_CHUNK to a value that fits in type size_t.
  324. Try adding "#define MAX_ALLOC_CHUNK 65520L" to jconfig.h.  A less likely
  325. configuration error is "ALIGN_TYPE is wrong, please fix": defining ALIGN_TYPE
  326. as long should take care of that one.
  327.  
  328. If the cjpeg test run fails with "Missing Huffman code table entry", it's a
  329. good bet that you needed to define RIGHT_SHIFT_IS_UNSIGNED.  Go back to the
  330. configuration step and run ckconfig.c.  (This is a good plan for any other
  331. test failure, too.)
  332.  
  333. If you are using Unix (one-file) command line style on a non-Unix system,
  334. it's a good idea to check that binary I/O through stdin/stdout actually
  335. works.  You should get the same results from "djpeg <testorig.jpg >out.ppm"
  336. as from "djpeg -outfile out.ppm testorig.jpg".  Note that the makefiles all
  337. use the latter style and therefore do not exercise stdin/stdout!  If this
  338. check fails, try recompiling with USE_SETMODE or USE_FDOPEN defined.
  339. If it still doesn't work, better use two-file style.
  340.  
  341. If you chose a memory manager other than jmemnobs.c, you should test that
  342. temporary-file usage works.  Try "djpeg -gif -max 0 testorig.jpg" and make
  343. sure its output matches testimg.gif.  If you have any really large images
  344. handy, try compressing them with -optimize and/or decompressing with -gif to
  345. make sure your DEFAULT_MAX_MEM setting is not too large.
  346.  
  347. NOTE: this is far from an exhaustive test of the JPEG software; some modules,
  348. such as 1-pass color quantization, are not exercised at all.  It's just a
  349. quick test to give you some confidence that you haven't missed something
  350. major.
  351.  
  352.  
  353. INSTALLING THE SOFTWARE
  354. =======================
  355.  
  356. Once you're done with the above steps, you can install the software by
  357. copying the executable files (cjpeg, djpeg, jpegtran, rdjpgcom, and wrjpgcom)
  358. to wherever you normally install programs.  On Unix systems, you'll also want
  359. to put the man pages (cjpeg.1, djpeg.1, jpegtran.1, rdjpgcom.1, wrjpgcom.1)
  360. in the man-page directory.  The canned makefiles don't support this step
  361. since there's such a wide variety of installation procedures on different
  362. systems.
  363.  
  364. If you generated a Makefile with the "configure" script, you can just say
  365.     make install
  366. to install the programs and their man pages into the standard places.
  367. (You'll probably need to be root to do this.)  We recommend first saying
  368.     make -n install
  369. to see where configure thought the files should go.  You may need to edit
  370. the Makefile, particularly if your system's conventions for man page
  371. filenames don't match what configure expects.
  372.  
  373. If you want to install the library file libjpeg.a and the include files j*.h
  374. (for use in compiling other programs besides the IJG ones), then say
  375.     make install-lib
  376.  
  377.  
  378. OPTIONAL STUFF
  379. ==============
  380.  
  381. Progress monitor:
  382.  
  383. If you like, you can #define PROGRESS_REPORT (in jconfig.h) to enable display
  384. of percent-done progress reports.  The routine provided in cdjpeg.c merely
  385. prints percentages to stderr, but you can customize it to do something
  386. fancier.
  387.  
  388. Utah RLE file format support:
  389.  
  390. We distribute the software with support for RLE image files (Utah Raster
  391. Toolkit format) disabled, because the RLE support won't compile without the
  392. Utah library.  If you have URT version 3.1 or later, you can enable RLE
  393. support as follows:
  394.     1.  #define RLE_SUPPORTED in jconfig.h.
  395.     2.  Add a -I option to CFLAGS in the Makefile for the directory
  396.         containing the URT .h files (typically the "include"
  397.         subdirectory of the URT distribution).
  398.     3.  Add -L... -lrle to LDLIBS in the Makefile, where ... specifies
  399.         the directory containing the URT "librle.a" file (typically the
  400.         "lib" subdirectory of the URT distribution).
  401.  
  402. Support for 12-bit-deep pixel data:
  403.  
  404. The JPEG standard allows either 8-bit or 12-bit data precision.  (For color,
  405. this means 8 or 12 bits per channel, of course.)  If you need to work with
  406. deeper than 8-bit data, you can compile the IJG code for 12-bit operation.
  407. To do so:
  408.   1. In jmorecfg.h, define BITS_IN_JSAMPLE as 12 rather than 8.
  409.   2. In jconfig.h, undefine BMP_SUPPORTED, RLE_SUPPORTED, and TARGA_SUPPORTED,
  410.      because the code for those formats doesn't handle 12-bit data and won't
  411.      even compile.  (The PPM code does work, as explained below.  The GIF
  412.      code works too; it scales 8-bit GIF data to and from 12-bit depth
  413.      automatically.)
  414.   3. Compile.  Don't expect "make test" to pass, since the supplied test
  415.      files are for 8-bit data.
  416.  
  417. Currently, 12-bit support does not work on 16-bit-int machines.
  418.  
  419. Note that a 12-bit version will not read 8-bit JPEG files, nor vice versa;
  420. so you'll want to keep around a regular 8-bit compilation as well.
  421. (Run-time selection of data depth, to allow a single copy that does both,
  422. is possible but would probably slow things down considerably; it's very low
  423. on our to-do list.)
  424.  
  425. The PPM reader (rdppm.c) can read 12-bit data from either text-format or
  426. binary-format PPM and PGM files.  Binary-format PPM/PGM files which have a
  427. maxval greater than 255 are assumed to use 2 bytes per sample, LSB first
  428. (little-endian order).  As of early 1995, 2-byte binary format is not
  429. officially supported by the PBMPLUS library, but it is expected that the
  430. next release of PBMPLUS will support it.  Note that the PPM reader will
  431. read files of any maxval regardless of the BITS_IN_JSAMPLE setting; incoming
  432. data is automatically rescaled to either maxval=255 or maxval=4095 as
  433. appropriate for the cjpeg bit depth.
  434.  
  435. The PPM writer (wrppm.c) will normally write 2-byte binary PPM or PGM
  436. format, maxval 4095, when compiled with BITS_IN_JSAMPLE=12.  Since this
  437. format is not yet widely supported, you can disable it by compiling wrppm.c
  438. with PPM_NORAWWORD defined; then the data is scaled down to 8 bits to make a
  439. standard 1-byte/sample PPM or PGM file.  (Yes, this means still another copy
  440. of djpeg to keep around.  But hopefully you won't need it for very long.
  441. Poskanzer's supposed to get that new PBMPLUS release out Real Soon Now.)
  442.  
  443. Of course, if you are working with 12-bit data, you probably have it stored
  444. in some other, nonstandard format.  In that case you'll probably want to
  445. write your own I/O modules to read and write your format.
  446.  
  447. Note that a 12-bit version of cjpeg always runs in "-optimize" mode, in
  448. order to generate valid Huffman tables.  This is necessary because our
  449. default Huffman tables only cover 8-bit data.
  450.  
  451. Removing code:
  452.  
  453. If you need to make a smaller version of the JPEG software, some optional
  454. functions can be removed at compile time.  See the xxx_SUPPORTED #defines in
  455. jconfig.h and jmorecfg.h.  If at all possible, we recommend that you leave in
  456. decoder support for all valid JPEG files, to ensure that you can read anyone's
  457. output.  Taking out support for image file formats that you don't use is the
  458. most painless way to make the programs smaller.  Another possibility is to
  459. remove some of the DCT methods: in particular, the "IFAST" method may not be
  460. enough faster than the others to be worth keeping on your machine.  (If you
  461. do remove ISLOW or IFAST, be sure to redefine JDCT_DEFAULT or JDCT_FASTEST
  462. to a supported method, by adding a #define in jconfig.h.)
  463.  
  464.  
  465. OPTIMIZATION
  466. ============
  467.  
  468. Unless you own a Cray, you'll probably be interested in making the JPEG
  469. software go as fast as possible.  This section covers some machine-dependent
  470. optimizations you may want to try.  We suggest that before trying any of
  471. this, you first get the basic installation to pass the self-test step.
  472. Repeat the self-test after any optimization to make sure that you haven't
  473. broken anything.
  474.  
  475. The integer DCT routines perform a lot of multiplications.  These
  476. multiplications must yield 32-bit results, but none of their input values
  477. are more than 16 bits wide.  On many machines, notably the 680x0 and 80x86
  478. CPUs, a 16x16=>32 bit multiply instruction is faster than a full 32x32=>32
  479. bit multiply.  Unfortunately there is no portable way to specify such a
  480. multiplication in C, but some compilers can generate one when you use the
  481. right combination of casts.  See the MULTIPLYxxx macro definitions in
  482. jdct.h.  If your compiler makes "int" be 32 bits and "short" be 16 bits,
  483. defining SHORTxSHORT_32 is fairly likely to work.  When experimenting with
  484. alternate definitions, be sure to test not only whether the code still works
  485. (use the self-test), but also whether it is actually faster --- on some
  486. compilers, alternate definitions may compute the right answer, yet be slower
  487. than the default.  Timing cjpeg on a large PGM (grayscale) input file is the
  488. best way to check this, as the DCT will be the largest fraction of the runtime
  489. in that mode.  (Note: some of the distributed compiler-specific jconfig files
  490. already contain #define switches to select appropriate MULTIPLYxxx
  491. definitions.)
  492.  
  493. If your machine has sufficiently fast floating point hardware, you may find
  494. that the float DCT method is faster than the integer DCT methods, even
  495. after tweaking the integer multiply macros.  In that case you may want to
  496. make the float DCT be the default method.  (The only objection to this is
  497. that float DCT results may vary slightly across machines.)  To do that, add
  498. "#define JDCT_DEFAULT JDCT_FLOAT" to jconfig.h.  Even if you don't change
  499. the default, you should redefine JDCT_FASTEST, which is the method selected
  500. by djpeg's -fast switch.  Don't forget to update the documentation files
  501. (usage.doc and/or cjpeg.1, djpeg.1) to agree with what you've done.
  502.  
  503. If access to "short" arrays is slow on your machine, it may be a win to
  504. define type JCOEF as int rather than short.  This will cost a good deal of
  505. memory though, particularly in some multi-pass modes, so don't do it unless
  506. you have memory to burn and short is REALLY slow.
  507.  
  508. If your compiler can compile function calls in-line, make sure the INLINE
  509. macro in jmorecfg.h is defined as the keyword that marks a function
  510. inline-able.  Some compilers have a switch that tells the compiler to inline
  511. any function it thinks is profitable (e.g., -finline-functions for gcc).
  512. Enabling such a switch is likely to make the compiled code bigger but faster.
  513.  
  514. In general, it's worth trying the maximum optimization level of your compiler,
  515. and experimenting with any optional optimizations such as loop unrolling.
  516. (Unfortunately, far too many compilers have optimizer bugs ... be prepared to
  517. back off if the code fails self-test.)  If you do any experimentation along
  518. these lines, please report the optimal settings to jpeg-info@uunet.uu.net so
  519. we can mention them in future releases.  Be sure to specify your machine and
  520. compiler version.
  521.  
  522.  
  523. HINTS FOR SPECIFIC SYSTEMS
  524. ==========================
  525.  
  526. We welcome reports on changes needed for systems not mentioned here.  Submit
  527. 'em to jpeg-info@uunet.uu.net.  Also, if configure or ckconfig.c is wrong
  528. about how to configure the JPEG software for your system, please let us know.
  529.  
  530.  
  531. Acorn RISC OS:
  532.  
  533. (Thanks to Simon Middleton for these hints on compiling with Desktop C.)
  534. After renaming the files according to Acorn conventions, take a copy of
  535. makefile.ansi, change all occurrences of 'libjpeg.a' to 'libjpeg.o' and
  536. change these definitions as indicated:
  537.  
  538. CFLAGS= -throwback -IC: -Wn
  539. LDLIBS=C:o.Stubs
  540. SYSDEPMEM=jmemansi.o
  541. LN=Link
  542. AR=LibFile -c -o
  543.  
  544. Also add a new line '.c.o:; $(cc) $< $(cflags) -c -o $@'.  Remove the
  545. lines '$(RM) libjpeg.o' and '$(AR2) libjpeg.o' and the 'jconfig.h'
  546. dependency section.
  547.  
  548. Copy jconfig.doc to jconfig.h.  Edit jconfig.h to define TWO_FILE_COMMANDLINE
  549. and CHAR_IS_UNSIGNED.
  550.  
  551. Run the makefile using !AMU not !Make.  If you want to use the 'clean' and
  552. 'test' makefile entries then you will have to fiddle with the syntax a bit
  553. and rename the test files.
  554.  
  555.  
  556. Amiga:
  557.  
  558. SAS C 6.50 reportedly is too buggy to compile the IJG code properly.
  559. A patch to update to 6.51 is available from SAS or AmiNet FTP sites.
  560.  
  561. The supplied config files are set up to use jmemname.c as the memory
  562. manager, with temporary files being created on the device named by
  563. "JPEGTMP:".
  564.  
  565.  
  566. Atari ST/STE/TT:
  567.  
  568. Copy the project files makcjpeg.st, makdjpeg.st, maktjpeg.st, and makljpeg.st
  569. to cjpeg.prj, djpeg.prj, jpegtran.prj, and libjpeg.prj respectively.  The
  570. project files should work as-is with Pure C.  For Turbo C, change library
  571. filenames "PC..." to "TC..." in each project file.  Note that libjpeg.prj
  572. selects jmemansi.c as the recommended memory manager.  You'll probably want to
  573. adjust the DEFAULT_MAX_MEM setting --- you want it to be a couple hundred K
  574. less than your normal free memory.  Put "#define DEFAULT_MAX_MEM nnnn" into
  575. jconfig.h to do this.
  576.  
  577. To use the 68881/68882 coprocessor for the floating point DCT, add the
  578. compiler option "-8" to the project files and replace PCFLTLIB.LIB with
  579. PC881LIB.LIB in cjpeg.prj and djpeg.prj.  Or if you don't have a
  580. coprocessor, you may prefer to remove the float DCT code by undefining
  581. DCT_FLOAT_SUPPORTED in jmorecfg.h (since without a coprocessor, the float
  582. code will be too slow to be useful).  In that case, you can delete
  583. PCFLTLIB.LIB from the project files.
  584.  
  585. Note that you must make libjpeg.lib before making cjpeg.ttp, djpeg.ttp,
  586. or jpegtran.ttp.  You'll have to perform the self-test by hand.
  587.  
  588. We haven't bothered to include project files for rdjpgcom and wrjpgcom.
  589. Those source files should just be compiled by themselves; they don't
  590. depend on the JPEG library.
  591.  
  592. There is a bug in some older versions of the Turbo C library which causes the
  593. space used by temporary files created with "tmpfile()" not to be freed after
  594. an abnormal program exit.  If you check your disk afterwards, you will find
  595. cluster chains that are allocated but not used by a file.  This should not
  596. happen in cjpeg/djpeg/jpegtran, since we enable a signal catcher to explicitly
  597. close temp files before exiting.  But if you use the JPEG library with your
  598. own code, be sure to supply a signal catcher, or else use a different
  599. system-dependent memory manager.
  600.  
  601.  
  602. Cray:
  603.  
  604. Should you be so fortunate as to be running JPEG on a Cray YMP, there is a
  605. compiler bug in old versions of Cray's Standard C (prior to 3.1).  If you
  606. still have an old compiler, you'll need to insert a line reading
  607. "#pragma novector" just before the loop    
  608.     for (i = 1; i <= (int) htbl->bits[l]; i++)
  609.       huffsize[p++] = (char) l;
  610. in fix_huff_tbl (in V5beta1, line 204 of jchuff.c and line 176 of jdhuff.c).
  611. [This bug may or may not still occur with the current IJG code, but it's
  612. probably a dead issue anyway...]
  613.  
  614.  
  615. HP-UX:
  616.  
  617. If you have HP-UX 7.05 or later with the "software development" C compiler,
  618. you should run the compiler in ANSI mode.  If using the configure script,
  619. say
  620.     ./configure CC='cc -Aa'
  621. (or -Ae if you prefer).  If configuring by hand, use makefile.ansi and add
  622. "-Aa" to the CFLAGS line in the makefile.
  623.  
  624. If you have a pre-7.05 system, or if you are using the non-ANSI C compiler
  625. delivered with a minimum HP-UX system, then you must use makefile.unix
  626. (and do NOT add -Aa); or just run configure without the CC option.
  627.  
  628. On HP 9000 series 800 machines, the HP C compiler is buggy in revisions prior
  629. to A.08.07.  If you get complaints about "not a typedef name", you'll have to
  630. use makefile.unix, or run configure without the CC option.
  631.  
  632.  
  633. Macintosh, generic comments:
  634.  
  635. The supplied user-interface files (cjpeg.c, djpeg.c, etc) are set up to
  636. provide a Unix-style command line interface.  You can use this interface on
  637. the Mac by means of the ccommand() library routine provided by Metrowerks
  638. CodeWarrior or Think C.  This is only appropriate for testing the library,
  639. however; to make a user-friendly equivalent of cjpeg/djpeg you'd really want
  640. to develop a Mac-style user interface.  Such an interface exists for pre-v5
  641. IJG libraries (see the Think C entry, below) but at this writing it has not
  642. been updated to work with the current release.
  643.  
  644. We recommend replacing "malloc" and "free" by "NewPtr" and "DisposePtr" in
  645. whichever memory manager back end you use, because Mac C libraries often
  646. have inferior implementations of malloc/free.  jmemmac.c is recommended;
  647. it is a customized version of jmemansi.c with this change and a Mac-specific
  648. implementation of jpeg_mem_available().  You can also use jmemnobs.c if you
  649. don't care about handling images larger than available memory.
  650.  
  651.  
  652. Macintosh, MPW:
  653.  
  654. We don't directly support MPW in the current release, but Larry Rosenstein
  655. ported an earlier version of the IJG code without very much trouble.  There's
  656. useful notes and conversion scripts in his kit for porting PBMPLUS to MPW.
  657. You can obtain the kit by FTP to ftp.apple.com, files /pub/lsr/pbmplus-port*.
  658.  
  659.  
  660. Macintosh, Metrowerks CodeWarrior:
  661.  
  662. Metrowerks release DR2 has problems with the IJG code; don't use it.  Release
  663. DR3.5 or later should be OK.
  664.  
  665. The Unix-command-line-style interface can be used by defining USE_CCOMMAND.
  666. You'll also need to define either TWO_FILE_COMMANDLINE (to avoid stdin/stdout)
  667. or USE_FDOPEN (to make stdin/stdout work in binary mode).  See the Think C
  668. entry for more details.
  669.  
  670. On 680x0 Macs, Metrowerks defines type "double" as a 10-byte IEEE extended
  671. float.  jmemmgr.c won't like this: it wants sizeof(ALIGN_TYPE) to be a power
  672. of 2.  Add "#define ALIGN_TYPE long" to jconfig.h to eliminate the complaint.
  673.  
  674.  
  675. Macintosh, Think C:
  676.  
  677. Jim Brunner has prepared a Mac-style user interface for the IJG library.
  678. Unfortunately, the released version of it only works with pre-v5 libraries;
  679. still, it may be a useful starting point.  You can obtain Jim's additional
  680. source code from the Info-Mac archives, at sumex-aim.stanford.edu or mirrors
  681. thereof; see file /info-mac/dev/src/jpeg-convert-c.hqx.  Jim's documentation
  682. also includes more detailed build instructions for Think C.
  683.  
  684. If you want to build the minimal command line version, proceed as follows.
  685. You'll have to prepare project files for the programs; we don't include any
  686. in the distribution since they are not text files.  Use the file lists in
  687. any of the supplied makefiles as a guide.  Also add the ANSI and Unix C
  688. libraries in a separate segment.  You may need to divide the JPEG files into
  689. more than one segment; we recommend dividing compression and decompression
  690. modules.  Define USE_CCOMMAND in jconfig.h so that the ccommand() routine is
  691. called.  You must also define TWO_FILE_COMMANDLINE because stdin/stdout
  692. don't handle binary data correctly.
  693.  
  694. On 680x0 Macs, Think C defines type "double" as a 12-byte IEEE extended float.
  695. jmemmgr.c won't like this: it wants sizeof(ALIGN_TYPE) to be a power of 2.
  696. Add "#define ALIGN_TYPE long" to jconfig.h to eliminate the complaint.
  697.  
  698.  
  699. MIPS R3000:
  700.  
  701. MIPS's cc version 1.31 has a rather nasty optimization bug.  Don't use -O
  702. if you have that compiler version.  (Use "cc -V" to check the version.)
  703. Note that the R3000 chip is found in workstations from DEC and others.
  704.  
  705.  
  706. MS-DOS, generic comments for 16-bit compilers:
  707.  
  708. The IJG code is designed to be compiled in 80x86 "small" or "medium" memory
  709. models (i.e., data pointers are 16 bits unless explicitly declared "far";
  710. code pointers can be either size).  You may be able to use small model to
  711. compile cjpeg or djpeg by itself, but you will probably have to use medium
  712. model for any larger application.  This won't make much difference in
  713. performance.  You *will* take a noticeable performance hit if you use a
  714. large-data memory model, and you should avoid "huge" model if at all
  715. possible.  Be sure that NEED_FAR_POINTERS is defined in jconfig.h if you use
  716. a small-data memory model; be sure it is NOT defined if you use a large-data
  717. model.  (The supplied makefiles and jconfig files for Borland and Microsoft C
  718. compile in medium model and define NEED_FAR_POINTERS.)
  719.  
  720. The DOS-specific memory manager, jmemdos.c, should be used if possible.
  721. It needs some assembly-code routines which are in jmemdosa.asm; make sure
  722. your makefile assembles that file and includes it in the library.  If you
  723. don't have a suitable assembler, you can get pre-assembled object files for
  724. jmemdosa by FTP from ftp.uu.net: graphics/jpeg/jdosaobj.zip.  (DOS-oriented
  725. distributions of the IJG source code often include these object files.)
  726.  
  727. When using jmemdos.c, jconfig.h must define USE_MSDOS_MEMMGR and must set
  728. MAX_ALLOC_CHUNK to less than 64K (65520L is a typical value).  If your
  729. C library's far-heap malloc() can't allocate blocks that large, reduce
  730. MAX_ALLOC_CHUNK to whatever it can handle.
  731.  
  732. If you can't use jmemdos.c for some reason --- for example, because you
  733. don't have an assembler to assemble jmemdosa.asm --- you'll have to fall
  734. back to jmemansi.c or jmemname.c.  You'll probably still need to set
  735. MAX_ALLOC_CHUNK in jconfig.h, because most DOS C libraries won't malloc()
  736. more than 64K at a time.  IMPORTANT: if you use jmemansi.c or jmemname.c,
  737. you will have to compile in a large-data memory model in order to get the
  738. right stdio library.  Too bad.
  739.  
  740. wrjpgcom needs to be compiled in large model, because it malloc()s a 64KB
  741. work area to hold the comment text.  If your C library's malloc can't
  742. handle that, reduce MAX_COM_LENGTH as necessary in wrjpgcom.c.
  743.  
  744. Most MS-DOS compilers treat stdin/stdout as text files, so you must use
  745. two-file command line style.  But if your compiler has either fdopen() or
  746. setmode(), you can use one-file style if you like.  To do this, define
  747. USE_SETMODE or USE_FDOPEN so that stdin/stdout will be set to binary mode.
  748. (USE_SETMODE seems to work with more DOS compilers than USE_FDOPEN.)  You
  749. should test that I/O through stdin/stdout produces the same results as I/O
  750. to explicitly named files... the "make test" procedures in the supplied
  751. makefiles do NOT use stdin/stdout.
  752.  
  753.  
  754. MS-DOS, generic comments for 32-bit compilers:
  755.  
  756. None of the above comments about memory models apply if you are using a
  757. 32-bit flat-memory-space environment, such as DJGPP or Watcom C.  (And you
  758. should use one if you have it, as performance will be much better than
  759. 8086-compatible code!)  For flat-memory-space compilers, do NOT define
  760. NEED_FAR_POINTERS, and do NOT use jmemdos.c.  Use jmemnobs.c if the
  761. environment supplies adequate virtual memory, otherwise use jmemansi.c or
  762. jmemname.c.
  763.  
  764. You'll still need to be careful about binary I/O through stdin/stdout.
  765. See the last paragraph of the previous section.
  766.  
  767.  
  768. MS-DOS, Borland C:
  769.  
  770. Be sure to convert all the source files to DOS text format (CR/LF newlines).
  771. Although Borland C will often work OK with unmodified Unix (LF newlines)
  772. source files, sometimes it will give bogus compile errors.
  773. "Illegal character '#'" is the most common such error.  (This is true with
  774. Borland C 3.1, but perhaps is fixed in newer releases.)
  775.  
  776. If you want one-file command line style, just undefine TWO_FILE_COMMANDLINE.
  777. jconfig.bcc already includes #define USE_SETMODE to make this work.
  778. (fdopen does not work correctly.)
  779.  
  780.  
  781. MS-DOS, DJGPP:
  782.  
  783. Use a recent version of DJGPP (1.11 or better).  If you prefer two-file
  784. command line style, change the supplied jconfig.dj to define
  785. TWO_FILE_COMMANDLINE.  makefile.dj is set up to generate only COFF files
  786. (cjpeg, djpeg, etc) when you say make.  After testing, say "make exe" to
  787. make executables with stub.exe, or "make standalone" if you want executables
  788. that include go32.  You will probably need to tweak the makefile's pointer to
  789. go32.exe to do "make standalone".
  790.  
  791.  
  792. MS-DOS, Microsoft C:
  793.  
  794. makefile.mc6 works with Microsoft C, Visual C++, etc.  Note that this
  795. makefile assumes that the working copy of itself is called "makefile".
  796. If you want to call it something else, say "makefile.mak", be sure to adjust
  797. the dependency line that reads "$(RFILE) : makefile".  Otherwise the make
  798. will fail because it doesn't know how to create "makefile".  Worse, some
  799. releases of Microsoft's make utilities give an incorrect error message in
  800. this situation.
  801.  
  802. If you want one-file command line style, just undefine TWO_FILE_COMMANDLINE.
  803. jconfig.mc6 already includes #define USE_SETMODE to make this work.
  804. (fdopen does not work correctly.)
  805.  
  806. Old versions of MS C fail with an "out of macro expansion space" error
  807. because they can't cope with the macro TRACEMS8 (defined in jerror.h).
  808. If this happens to you, the easiest solution is to change TRACEMS8 to
  809. expand to nothing.  You'll lose the ability to dump out JPEG coefficient
  810. tables with djpeg -debug -debug, but at least you can compile.
  811.  
  812. Original MS C 6.0 is very buggy; it compiles incorrect code unless you turn
  813. off optimization entirely (remove -O from CFLAGS).  6.00A is better, but it
  814. still generates bad code if you enable loop optimizations (-Ol or -Ox).
  815.  
  816. MS C 8.0 reportedly fails to compile jquant1.c if optimization is turned off
  817. (yes, off).
  818.  
  819.  
  820. Microsoft Windows (all versions):
  821.  
  822. Some Windows system include files define typedef boolean as "unsigned char".
  823. The IJG code also defines typedef boolean, but we make it "int" by default.
  824. This doesn't affect the IJG programs because we don't import those Windows
  825. include files.  But if you use the JPEG library in your own program, and some
  826. of your program's files import one definition of boolean while some import the
  827. other, you can get all sorts of mysterious problems.  A good preventive step
  828. is to change jmorecfg.h to define boolean as unsigned char.  We recommend
  829. making that part of jmorecfg.h read like this:
  830.     #ifndef __RPCNDR_H__    /* don't conflict if rpcndr.h already read */
  831.     typedef unsigned char boolean;
  832.     #endif
  833. In v6a and later, using incompatible definitions of boolean will usually lead
  834. to the failure message "JPEG parameter struct mismatch", rather than the
  835. difficult-to-diagnose bugs it caused with earlier versions.
  836.  
  837. When using the library in a Windows application, you will almost certainly
  838. want to modify or replace the error handler module jerror.c, since our
  839. default error handler does a couple of inappropriate things:
  840.   1. it tries to write error and warning messages on stderr;
  841.   2. in event of a fatal error, it exits by calling exit().
  842. A simple stopgap solution for problem 1 is to replace the line
  843.     fprintf(stderr, "%s\n", buffer);
  844. (in output_message in jerror.c) with something like
  845.     MessageBox(GetActiveWindow(),buffer,"JPEG Error",MB_OK);
  846. It's highly recommended that you at least do that much, since otherwise
  847. error messages will disappear into nowhere.
  848. The proper solution for problem 2 is to return control to your calling
  849. application after a library error.  This can be done with the setjmp/longjmp
  850. technique discussed in libjpeg.doc and illustrated in example.c.
  851.  
  852. You may also want to modify jdatasrc.c and jdatadst.c to use Windows file
  853. operations rather than fread/fwrite.  This is only necessary if your C
  854. compiler doesn't provide a competent implementation of C stdio functions.
  855.  
  856. Many people want to convert the IJG library into a DLL.  This is reasonably
  857. straightforward, but watch out for the following:
  858.   1. Don't try to compile as a DLL in small or medium memory model; use
  859. large model, or even better, 32-bit flat model.  Many places in the IJG code
  860. assume the address of a local variable is an ordinary (not FAR) pointer;
  861. that isn't true in a medium-model DLL.
  862.   2. Microsoft C cannot pass file pointers between applications and DLLs.
  863. (See Microsoft Knowledge Base, PSS ID Number Q50336.)  So jdatasrc.c and
  864. jdatadst.c don't work if you open a file in your application and then pass
  865. the pointer to the DLL.  One workaround is to make jdatasrc.c/jdatadst.c
  866. part of your main application rather than part of the DLL.
  867.   3. You'll probably need to modify the macros GLOBAL() and EXTERN() to
  868. attach suitable linkage keywords to the exported routine names.  Similarly,
  869. you'll want to modify METHODDEF() and JMETHOD() to ensure function pointers
  870. are declared in a way that lets application routines be called back through
  871. the function pointers.  These macros are in jmorecfg.h.  Typical definitions
  872. for a 16-bit DLL are:
  873.     #define GLOBAL(type)        type _far _pascal _loadds _export
  874.     #define EXTERN(type)        extern type _far _pascal
  875.     #define METHODDEF(type)        static type _far _pascal
  876.     #define JMETHOD(type,methodname,arglist)  \
  877.         type (_far _pascal *methodname) arglist
  878. Although not all the GLOBAL routines are actually intended to be called by
  879. the application, the performance cost of making them all DLL entry points is
  880. negligible.
  881.  
  882. The unmodified IJG library presents a very C-specific application interface,
  883. so the resulting DLL is only usable from C or C++ applications.  There has
  884. been some talk of writing wrapper code that would present a simpler interface
  885. usable from other languages, such as Visual Basic.  This is on our to-do list
  886. but hasn't been very high priority --- any volunteers out there?
  887.  
  888.  
  889. Microsoft Windows, Borland C:
  890.  
  891. Borland C++ 4.5 fails with an internal compiler error when trying to compile
  892. jdmerge.c in 32-bit mode.  If enough people complain, perhaps Borland will fix
  893. it.  In the meantime, the simplest known workaround is to add a redundant
  894. definition of the variable range_limit in h2v1_merged_upsample(), at the head
  895. of the block that handles odd image width (about line 268 in v6 jdmerge.c):
  896.   /* If image width is odd, do the last output column separately */
  897.   if (cinfo->output_width & 1) {
  898.     register JSAMPLE * range_limit = cinfo->sample_range_limit; /* ADD THIS */
  899.     cb = GETJSAMPLE(*inptr1);
  900. Pretty bizarre, especially since the very similar routine h2v2_merged_upsample
  901. doesn't trigger the bug.
  902. Recent reports suggest that this bug does not occur with "bcc32a" (the
  903. Pentium-optimized version of the compiler).
  904.  
  905.  
  906. SGI:
  907.  
  908. On some SGI systems, you may need to set "AR2= ar -ts" in the Makefile.
  909. If you are using configure, you can do this by saying
  910.     ./configure RANLIB='ar -ts'
  911. This change is not needed on all SGIs.  Use it only if the make fails at the
  912. stage of linking the completed programs.
  913.  
  914. On the MIPS R4000 architecture (Indy, etc.), the compiler option "-mips2"
  915. reportedly speeds up the float DCT method substantially, enough to make it
  916. faster than the default int method (but still slower than the fast int
  917. method).  If you use -mips2, you may want to alter the default DCT method to
  918. be float.  To do this, put "#define JDCT_DEFAULT JDCT_FLOAT" in jconfig.h.
  919.  
  920.  
  921. VMS:
  922.  
  923. On an Alpha/VMS system with MMS, be sure to use the "/Marco=Alpha=1"
  924. qualifier with MMS when building the JPEG package.
  925.  
  926. VAX/VMS v5.5-1 may have problems with the test step of the build procedure
  927. reporting differences when it compares the original and test images.  If the
  928. error points to the last block of the files, it is most likely bogus and may
  929. be safely ignored.  It seems to be because the files are Stream_LF and
  930. Backup/Compare has difficulty with the (presumably) null padded files.
  931. This problem was not observed on VAX/VMS v6.1 or AXP/VMS v6.1.
  932.